<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class RequestProcessor</title>
			<link rel="stylesheet" href="../../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Class RequestProcessor</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
													<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
						|											<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">RequestProcessor class</p>
<p class="description"><p>&lt;strong&gt;RequestProcessor&lt;/strong&gt; contains the processing logic that the  ActionServlet performs as it receives each servlet request from the  container. You can customize the request processing behavior by subclassing  this class and overriding the method(s) whose behavior you are interested  in changing.</p><p></p></p>
		<p class="notes">
			Located in <a class="field" href="_mvc---action---RequestProcessor.php.html">/mvc/action/RequestProcessor.php</a> (line <span class="field">43</span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>



	<a name="sec-var-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Variable Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
						<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
							| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
								</div>
		<div class="info-box-body">
			<div class="var-summary">
																								<div class="var-title">
					<span class="var-type">mixed</span>
					<a href="#$applicationContext" title="details" class="var-name">$applicationContext</a>
				</div>
											</div>
		</div>
	</div>

	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
																		<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
				 
				|
						<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																																																																																																																																												
												<div class="method-definition">
											<span class="method-result">RequestProcessor</span>
										<a href="#__construct" title="details" class="method-name">__construct</a>
											(<span class="var-type"><a href="../../php-mvc/ModuleConfig.html">ModuleConfig</a></span>&nbsp;<span class="var-name">&$config</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#doForward" title="details" class="method-name">doForward</a>
											(<span class="var-type">uri</span>&nbsp;<span class="var-name">$uri</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$request</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$response</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">The</span>
										<a href="#getApplicationContext" title="details" class="method-name">getApplicationContext</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#internalModuleRelativeForward" title="details" class="method-name">internalModuleRelativeForward</a>
											(<span class="var-type">uri</span>&nbsp;<span class="var-name">$uri</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$request</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$response</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#process" title="details" class="method-name">process</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">&$request</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$response</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">An</span>
										<a href="#processActionCreate" title="details" class="method-name">processActionCreate</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">&$request</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$response</span>, <span class="var-type"><a href="../../php-mvc/ActionConfig.html">ActionConfig</a></span>&nbsp;<span class="var-name">&$mapping</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">The</span>
										<a href="#processActionForm" title="details" class="method-name">processActionForm</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">&$request</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$response</span>, <span class="var-type"><a href="../../php-mvc/ActionConfig.html">ActionConfig</a></span>&nbsp;<span class="var-name">&$mapping</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">The</span>
										<a href="#processActionPerform" title="details" class="method-name">processActionPerform</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">&$request</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$response</span>, <span class="var-type"><a href="../../php-mvc/action/Action.html">Action</a></span>&nbsp;<span class="var-name">&$action</span>, <span class="var-type">form</span>&nbsp;<span class="var-name">&$form</span>, <span class="var-type"><a href="../../php-mvc/ActionConfig.html">ActionConfig</a></span>&nbsp;<span class="var-name">&$mapping</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">The</span>
										<a href="#processException" title="details" class="method-name">processException</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">&$request</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$response</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$exception</span>, <span class="var-type">form</span>&nbsp;<span class="var-name">&$form</span>, <span class="var-type"><a href="../../php-mvc/ActionConfig.html">ActionConfig</a></span>&nbsp;<span class="var-name">&$mapping</span>)
									</div>
																<div class="method-definition">
											<span class="method-result"><code>true</code></span>
										<a href="#processForward" title="details" class="method-name">processForward</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">&$request</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$response</span>, <span class="var-type"><a href="../../php-mvc/ActionConfig.html">ActionConfig</a></span>&nbsp;<span class="var-name">&$mapping</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#processForwardConfig" title="details" class="method-name">processForwardConfig</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">&$request</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$response</span>, <span class="var-type">forward</span>&nbsp;<span class="var-name">&$forward</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#processLocale" title="details" class="method-name">processLocale</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">&$request</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$response</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">The</span>
										<a href="#processMapping" title="details" class="method-name">processMapping</a>
											(<span class="var-type">request</span>&nbsp;<span class="var-name">&$request</span>, <span class="var-type">response</span>&nbsp;<span class="var-name">&$response</span>, <span class="var-type">path</span>&nbsp;<span class="var-name">$path</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">The</span>
										<a href="#processPath" title="details" class="method-name">processPath</a>
											(<span class="var-type">request</span>&nbsp;<span class="var-name">&$request</span>, <span class="var-type">response</span>&nbsp;<span class="var-name">1</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#processPopulate" title="details" class="method-name">processPopulate</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">&$request</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$response</span>, [<span class="var-type"><a href="../../php-mvc/action/ActionForm.html">ActionForm</a></span>&nbsp;<span class="var-name">&$form</span> = <span class="var-default">null</span>], <span class="var-type"><a href="../../php-mvc/ActionConfig.html">ActionConfig</a></span>&nbsp;<span class="var-name">&$mapping</span>)
									</div>
																<div class="method-definition">
											<span class="method-result"><code>true</code></span>
										<a href="#processRoles" title="details" class="method-name">processRoles</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">&$request</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$response</span>, <span class="var-type"><a href="../../php-mvc/ActionConfig.html">ActionConfig</a></span>&nbsp;<span class="var-name">&$mapping</span>)
									</div>
																<div class="method-definition">
											<span class="method-result"><code>true</code></span>
										<a href="#processValidate" title="details" class="method-name">processValidate</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">&$request</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$response</span>, <span class="var-type">form</span>&nbsp;<span class="var-name">&$form</span>, <span class="var-type"><a href="../../php-mvc/ActionConfig.html">ActionConfig</a></span>&nbsp;<span class="var-name">&$mapping</span>)
									</div>
								</div>
		</div>
	</div>		

	<a name="sec-vars"></a>
	<div class="info-box">
		<div class="info-box-title">Variables</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
										<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
						
			
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			<a name="var$applicationContext" id="$applicationContext"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$applicationContext</span>
			 = <span class="var-default"> null</span>			(line <span class="line-number">65</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">&lt;p&gt;The applicationContext with which we are associated.&lt;/p&gt;</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
						
		</div>
	</div>
	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
															<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
																	<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>

<a name="method__construct" id="__construct"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">Constructor __construct</span> (line <span class="line-number">71</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">RequestProcessor</span>
		<span class="method-name">
			__construct
		</span>
					(<span class="var-type"><a href="../../php-mvc/ModuleConfig.html">ModuleConfig</a></span>&nbsp;<span class="var-name">&$config</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"><a href="../../php-mvc/ModuleConfig.html">ModuleConfig</a></span>
				<span class="var-name">&$config</span>			</li>
				</ul>
		
			
	</div>
<a name="methoddoForward" id="doForward"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">doForward</span> (line <span class="line-number">777</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">&lt;p&gt;Do a forward to specified URI using a <div class="src-code"><ol><li><div class="src-line"><span class="src-id">Zend&nbsp;View</span></div></li>
</ol></div>.</p>
<p class="description"><p>This method is used by all internal method needing to do a  forward.&lt;/p&gt;</p></p>
	<ul class="tags">
				<li><span class="field">since:</span> Struts 1.1</li>
				<li><span class="field">throws:</span> IOException      if an input/output error occurs</li>
				<li><span class="field">throws:</span> ServletException if a servlet exception occurs</li>
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			doForward
		</span>
					(<span class="var-type">uri</span>&nbsp;<span class="var-name">$uri</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$request</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$response</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">uri</span>
				<span class="var-name">$uri</span><span class="var-description">: Context-relative URI to forward to</span>			</li>
					<li>
				<span class="var-type">response</span>
				<span class="var-name">&$request</span><span class="var-description">: Current page response</span>			</li>
					<li>
				<span class="var-type"><a href="../../http/Response.html">Response</a></span>
				<span class="var-name">&$response</span>			</li>
				</ul>
		
			
	</div>
<a name="methodgetApplicationContext" id="getApplicationContext"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getApplicationContext</span> (line <span class="line-number">809</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">&lt;p&gt;Return the <div class="src-code"><ol><li><div class="src-line"><span class="src-id">ApplicationContext</span></div></li>
</ol></div> for the web application in  which we are running.&lt;/p&gt;</p>
	<ul class="tags">
				<li><span class="field">return:</span> <div class="src-code"><ol><li><div class="src-line"><span class="src-id">ApplicationContext</span></div></li>
</ol></div> for the web application.</li>
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">The</span>
		<span class="method-name">
			getApplicationContext
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodinternalModuleRelativeForward" id="internalModuleRelativeForward"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">internalModuleRelativeForward</span> (line <span class="line-number">737</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">&lt;p&gt;Do a module relative forward to specified URI using request</p>
<p class="description"><p>dispatcher. URI is relative to the current module. The real URI is  compute by prefixing the module name.&lt;/p&gt; &lt;p&gt;This method is used  internally and is not part of the public API. It is advised to not use  it in subclasses. &lt;/p&gt;</p></p>
	<ul class="tags">
				<li><span class="field">since:</span> Struts 1.1</li>
				<li><span class="field">throws:</span> IOException      if an input/output error occurs</li>
				<li><span class="field">throws:</span> ServletException if a servlet exception occurs</li>
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			internalModuleRelativeForward
		</span>
					(<span class="var-type">uri</span>&nbsp;<span class="var-name">$uri</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$request</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$response</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">uri</span>
				<span class="var-name">$uri</span><span class="var-description">: Module-relative URI to forward to</span>			</li>
					<li>
				<span class="var-type">request</span>
				<span class="var-name">&$request</span><span class="var-description">: Current page request</span>			</li>
					<li>
				<span class="var-type">response</span>
				<span class="var-name">&$response</span><span class="var-description">: Current page response</span>			</li>
				</ul>
		
			
	</div>
<a name="methodprocess" id="process"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">process</span> (line <span class="line-number">80</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			process
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">&$request</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$response</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"></span>
				<span class="var-name">&$request</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">&$response</span>			</li>
				</ul>
		
			
	</div>
<a name="methodprocessActionCreate" id="processActionCreate"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">processActionCreate</span> (line <span class="line-number">181</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">&lt;p&gt;Return an <div class="src-code"><ol><li><div class="src-line"><span class="src-id"><a href="../../php-mvc/action/Action.html">Action</a></span></div></li>
</ol></div> instance that will be used to process  the current request, creating a new one if necessary.&lt;/p&gt;</p>
	<ul class="tags">
				<li><span class="field">return:</span> <div class="src-code"><ol><li><div class="src-line"><span class="src-id"><a href="../../php-mvc/action/Action.html">Action</a></span></div></li>
</ol></div> instance that will be used to process          the current request.</li>
				<li><span class="field">throws:</span> IOException if an input/output error occurs</li>
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">An</span>
		<span class="method-name">
			processActionCreate
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">&$request</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$response</span>, <span class="var-type"><a href="../../php-mvc/ActionConfig.html">ActionConfig</a></span>&nbsp;<span class="var-name">&$mapping</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">request</span>
				<span class="var-name">&$request</span><span class="var-description">: The servlet request we are processing</span>			</li>
					<li>
				<span class="var-type">response</span>
				<span class="var-name">&$response</span><span class="var-description">: The servlet response we are creating</span>			</li>
					<li>
				<span class="var-type">mapping</span>
				<span class="var-name">&$mapping</span><span class="var-description">: The mapping we are using</span>			</li>
				</ul>
		
			
	</div>
<a name="methodprocessActionForm" id="processActionForm"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">processActionForm</span> (line <span class="line-number">402</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">&lt;p&gt;Retrieve and return the <div class="src-code"><ol><li><div class="src-line"><span class="src-id"><a href="../../php-mvc/action/ActionForm.html">ActionForm</a></span></div></li>
</ol></div> associated with this</p>
<p class="description"><p>mapping, creating and retaining one if necessary. If there is no  <div class="src-code"><ol><li><div class="src-line"><span class="src-id"><a href="../../php-mvc/action/ActionForm.html">ActionForm</a></span></div></li>
</ol></div> associated with this mapping, return  <div class="src-code"><ol><li><div class="src-line"><span class="src-id">null</span></div></li>
</ol></div>.&lt;/p&gt;</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> <div class="src-code"><ol><li><div class="src-line"><span class="src-id"><a href="../../php-mvc/action/ActionForm.html">ActionForm</a></span></div></li>
</ol></div> associated with this mapping.</li>
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">The</span>
		<span class="method-name">
			processActionForm
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">&$request</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$response</span>, <span class="var-type"><a href="../../php-mvc/ActionConfig.html">ActionConfig</a></span>&nbsp;<span class="var-name">&$mapping</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">request</span>
				<span class="var-name">&$request</span><span class="var-description">: The servlet request we are processing</span>			</li>
					<li>
				<span class="var-type">response</span>
				<span class="var-name">&$response</span><span class="var-description">: The servlet response we are creating</span>			</li>
					<li>
				<span class="var-type">mapping</span>
				<span class="var-name">&$mapping</span><span class="var-description">: The mapping we are using</span>			</li>
				</ul>
		
			
	</div>
<a name="methodprocessActionPerform" id="processActionPerform"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">processActionPerform</span> (line <span class="line-number">239</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">&lt;P&gt;Ask the specified <div class="src-code"><ol><li><div class="src-line"><span class="src-id"><a href="../../php-mvc/action/Action.html">Action</a></span></div></li>
</ol></div> instance to handle this  request. Return the <div class="src-code"><ol><li><div class="src-line"><span class="src-id">ActionForward</span></div></li>
</ol></div> instance (if any)  returned by the called <div class="src-code"><ol><li><div class="src-line"><span class="src-id"><a href="../../php-mvc/action/Action.html">Action</a></span></div></li>
</ol></div> for further processing.</p>
<p class="description"><p>&lt;/P&gt;</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> <div class="src-code"><ol><li><div class="src-line"><span class="src-id">ActionForward</span></div></li>
</ol></div> instance (if any) returned by          the called <div class="src-code"><ol><li><div class="src-line"><span class="src-id"><a href="../../php-mvc/action/Action.html">Action</a></span></div></li>
</ol></div>.</li>
				<li><span class="field">throws:</span> ServletException if a servlet exception occurs</li>
				<li><span class="field">throws:</span> IOException      if an input/output error occurs</li>
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">The</span>
		<span class="method-name">
			processActionPerform
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">&$request</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$response</span>, <span class="var-type"><a href="../../php-mvc/action/Action.html">Action</a></span>&nbsp;<span class="var-name">&$action</span>, <span class="var-type">form</span>&nbsp;<span class="var-name">&$form</span>, <span class="var-type"><a href="../../php-mvc/ActionConfig.html">ActionConfig</a></span>&nbsp;<span class="var-name">&$mapping</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">request</span>
				<span class="var-name">&$request</span><span class="var-description">: The servlet request we are processing</span>			</li>
					<li>
				<span class="var-type">response</span>
				<span class="var-name">&$response</span><span class="var-description">: The servlet response we are creating</span>			</li>
					<li>
				<span class="var-type">action</span>
				<span class="var-name">&$action</span><span class="var-description">: The Action instance to be used</span>			</li>
					<li>
				<span class="var-type">form</span>
				<span class="var-name">&$form</span><span class="var-description">: The ActionForm instance to pass to this Action</span>			</li>
					<li>
				<span class="var-type">mapping</span>
				<span class="var-name">&$mapping</span><span class="var-description">: The ActionMapping instance to pass to this Action</span>			</li>
				</ul>
		
			
	</div>
<a name="methodprocessException" id="processException"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">processException</span> (line <span class="line-number">627</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">&lt;p&gt;Ask our exception handler to handle the exception. Return the  <div class="src-code"><ol><li><div class="src-line"><span class="src-id">ActionForward</span></div></li>
</ol></div> instance (if any) returned by the called  <div class="src-code"><ol><li><div class="src-line"><span class="src-id"><a href="../../php-mvc/action/ExceptionHandler.html">ExceptionHandler</a></span></div></li>
</ol></div>.&lt;/p&gt;</p>
	<ul class="tags">
				<li><span class="field">return:</span> <div class="src-code"><ol><li><div class="src-line"><span class="src-id">ActionForward</span></div></li>
</ol></div> instance (if any) returned by          the called <div class="src-code"><ol><li><div class="src-line"><span class="src-id"><a href="../../php-mvc/action/ExceptionHandler.html">ExceptionHandler</a></span></div></li>
</ol></div>.</li>
				<li><span class="field">throws:</span> ServletException if a servlet exception occurs</li>
				<li><span class="field">throws:</span> IOException      if an input/output error occurs</li>
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">The</span>
		<span class="method-name">
			processException
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">&$request</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$response</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$exception</span>, <span class="var-type">form</span>&nbsp;<span class="var-name">&$form</span>, <span class="var-type"><a href="../../php-mvc/ActionConfig.html">ActionConfig</a></span>&nbsp;<span class="var-name">&$mapping</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">request</span>
				<span class="var-name">&$request</span><span class="var-description">: The servlet request we are processing</span>			</li>
					<li>
				<span class="var-type">response</span>
				<span class="var-name">&$response</span><span class="var-description">: The servlet response we are processing</span>			</li>
					<li>
				<span class="var-type">exception</span>
				<span class="var-name">&$exception</span><span class="var-description">: The exception being handled</span>			</li>
					<li>
				<span class="var-type">form</span>
				<span class="var-name">&$form</span><span class="var-description">: The ActionForm we are processing</span>			</li>
					<li>
				<span class="var-type">mapping</span>
				<span class="var-name">&$mapping</span><span class="var-description">: The ActionMapping we are using</span>			</li>
				</ul>
		
			
	</div>
<a name="methodprocessForward" id="processForward"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">processForward</span> (line <span class="line-number">458</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">&lt;p&gt;Process a forward requested by this mapping (if any). Return  <div class="src-code"><ol><li><div class="src-line"><span class="src-id">true</span></div></li>
</ol></div> if standard processing should continue, or  <div class="src-code"><ol><li><div class="src-line"><span class="src-id">false</span></div></li>
</ol></div> if we have already handled this request.&lt;/p&gt;</p>
	<ul class="tags">
				<li><span class="field">return:</span> to continue normal processing;          <div class="src-code"><ol><li><div class="src-line"><span class="src-id">false</span></div></li>
</ol></div> if a response has been created.</li>
				<li><span class="field">throws:</span> ServletException if a servlet exception occurs</li>
				<li><span class="field">throws:</span> IOException      if an input/output error occurs</li>
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result"><code>true</code></span>
		<span class="method-name">
			processForward
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">&$request</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$response</span>, <span class="var-type"><a href="../../php-mvc/ActionConfig.html">ActionConfig</a></span>&nbsp;<span class="var-name">&$mapping</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">request</span>
				<span class="var-name">&$request</span><span class="var-description">: The servlet request we are processing</span>			</li>
					<li>
				<span class="var-type">response</span>
				<span class="var-name">&$response</span><span class="var-description">: The servlet response we are creating</span>			</li>
					<li>
				<span class="var-type">mapping</span>
				<span class="var-name">&$mapping</span><span class="var-description">: The ActionMapping we are using</span>			</li>
				</ul>
		
			
	</div>
<a name="methodprocessForwardConfig" id="processForwardConfig"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">processForwardConfig</span> (line <span class="line-number">679</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">&lt;p&gt;Forward or redirect to the specified destination, by the specified  mechanism.  This method uses a <div class="src-code"><ol><li><div class="src-line"><span class="src-id"><a href="../../php-mvc/ForwardConfig.html">ForwardConfig</a></span></div></li>
</ol></div> object  instead an <div class="src-code"><ol><li><div class="src-line"><span class="src-id">ActionForward</span></div></li>
</ol></div>.&lt;/p&gt;</p>
	<ul class="tags">
				<li><span class="field">throws:</span> ServletException if a servlet exception occurs</li>
				<li><span class="field">throws:</span> IOException      if an input/output error occurs</li>
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			processForwardConfig
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">&$request</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$response</span>, <span class="var-type">forward</span>&nbsp;<span class="var-name">&$forward</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">request</span>
				<span class="var-name">&$request</span><span class="var-description">: The servlet request we are processing</span>			</li>
					<li>
				<span class="var-type">response</span>
				<span class="var-name">&$response</span><span class="var-description">: The servlet response we are creating</span>			</li>
					<li>
				<span class="var-type">forward</span>
				<span class="var-name">&$forward</span><span class="var-description">: The ForwardConfig controlling where we go next</span>			</li>
				</ul>
		
			
	</div>
<a name="methodprocessLocale" id="processLocale"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">processLocale</span> (line <span class="line-number">258</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">&lt;p&gt;Automatically select a <div class="src-code"><ol><li><div class="src-line"><span class="src-id"><a href="../../http/Locale.html">Locale</a></span></div></li>
</ol></div> for the current user, if</p>
<p class="description"><p>requested. &lt;strong&gt;NOTE&lt;/strong&gt; - configuring Locale selection will  trigger the creation of a new <div class="src-code"><ol><li><div class="src-line"><span class="src-id">HttpSession</span></div></li>
</ol></div> if  necessary.&lt;/p&gt;</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			processLocale
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">&$request</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$response</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">request</span>
				<span class="var-name">&$request</span><span class="var-description">: The servlet request we are processing</span>			</li>
					<li>
				<span class="var-type">response</span>
				<span class="var-name">&$response</span><span class="var-description">: The servlet response we are creating</span>			</li>
				</ul>
		
			
	</div>
<a name="methodprocessMapping" id="processMapping"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">processMapping</span> (line <span class="line-number">295</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">&lt;p&gt;Select the mapping used to process the selection path for this  request. If no mapping can be identified, create an error response and  return <div class="src-code"><ol><li><div class="src-line"><span class="src-id">null</span></div></li>
</ol></div>.&lt;/p&gt;</p>
	<ul class="tags">
				<li><span class="field">return:</span> mapping used to process the selection path for this          request.</li>
				<li><span class="field">throws:</span> IOException if an input/output error occurs</li>
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">The</span>
		<span class="method-name">
			processMapping
		</span>
					(<span class="var-type">request</span>&nbsp;<span class="var-name">&$request</span>, <span class="var-type">response</span>&nbsp;<span class="var-name">&$response</span>, <span class="var-type">path</span>&nbsp;<span class="var-name">$path</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">request</span>
				<span class="var-name">&$request</span><span class="var-description">: The servlet request we are processing</span>			</li>
					<li>
				<span class="var-type">response</span>
				<span class="var-name">&$response</span><span class="var-description">: The servlet response we are creating</span>			</li>
					<li>
				<span class="var-type">path</span>
				<span class="var-name">$path</span><span class="var-description">: The portion of the request URI for selecting a mapping</span>			</li>
				</ul>
		
			
	</div>
<a name="methodprocessPath" id="processPath"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">processPath</span> (line <span class="line-number">154</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">&lt;p&gt;Identify and return the path component (from the request URI) that</p>
<p class="description"><p>we will use to select an <div class="src-code"><ol><li><div class="src-line"><span class="src-id">ActionMapping</span></div></li>
</ol></div> with which to  dispatch. If no such path can be identified, create an error response  and return <div class="src-code"><ol><li><div class="src-line"><span class="src-id">null</span></div></li>
</ol></div>.&lt;/p&gt;</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> path that will be used to select an action mapping.</li>
				<li><span class="field">throws:</span> IOException if an input/output error occurs</li>
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">The</span>
		<span class="method-name">
			processPath
		</span>
					(<span class="var-type">request</span>&nbsp;<span class="var-name">&$request</span>, <span class="var-type">response</span>&nbsp;<span class="var-name">1</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">response</span>
				<span class="var-name">1</span><span class="var-description">: The servlet response we are creating</span>			</li>
					<li>
				<span class="var-type">request</span>
				<span class="var-name">&$request</span><span class="var-description">: The servlet request we are processing</span>			</li>
				</ul>
		
			
	</div>
<a name="methodprocessPopulate" id="processPopulate"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">processPopulate</span> (line <span class="line-number">487</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">&lt;p&gt;Populate the properties of the specified <div class="src-code"><ol><li><div class="src-line"><span class="src-id"><a href="../../php-mvc/action/ActionForm.html">ActionForm</a></span></div></li>
</ol></div></p>
<p class="description"><p>instance from the request parameters included with this request.  In  addition, request attribute <div class="src-code"><ol><li><div class="src-line"><span class="src-id"><a href="../../php-mvc/MVC.html">MVC</a></span>.<span class="src-id">CANCEL_KEY</span></div></li>
</ol></div> will be set  if the request was submitted with a button created by  <div class="src-code"><ol><li><div class="src-line"><span class="src-id">CancelTag</span></div></li>
</ol></div>.&lt;/p&gt;</p></p>
	<ul class="tags">
				<li><span class="field">throws:</span> ServletException if thrown by RequestUtils.populate()</li>
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			processPopulate
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">&$request</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$response</span>, [<span class="var-type"><a href="../../php-mvc/action/ActionForm.html">ActionForm</a></span>&nbsp;<span class="var-name">&$form</span> = <span class="var-default">null</span>], <span class="var-type"><a href="../../php-mvc/ActionConfig.html">ActionConfig</a></span>&nbsp;<span class="var-name">&$mapping</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">request</span>
				<span class="var-name">&$request</span><span class="var-description">: The servlet request we are processing</span>			</li>
					<li>
				<span class="var-type">response</span>
				<span class="var-name">&$response</span><span class="var-description">: The servlet response we are creating</span>			</li>
					<li>
				<span class="var-type">form</span>
				<span class="var-name">&$form</span><span class="var-description">: The ActionForm instance we are populating</span>			</li>
					<li>
				<span class="var-type">mapping</span>
				<span class="var-name">&$mapping</span><span class="var-description">: The ActionMapping we are using</span>			</li>
				</ul>
		
			
	</div>
<a name="methodprocessRoles" id="processRoles"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">processRoles</span> (line <span class="line-number">349</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">&lt;p&gt;If this action is protected by security roles, make sure that the</p>
<p class="description"><p>current user possesses at least one of them.  Return <div class="src-code"><ol><li><div class="src-line"><span class="src-id">true</span></div></li>
</ol></div>  to continue normal processing, or <div class="src-code"><ol><li><div class="src-line"><span class="src-id">false</span></div></li>
</ol></div> if an appropriate  response has been created and processing should terminate.&lt;/p&gt;</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> to continue normal processing;          <div class="src-code"><ol><li><div class="src-line"><span class="src-id">false</span></div></li>
</ol></div> if a response has been created.</li>
				<li><span class="field">throws:</span> ServletException if a servlet exception occurs</li>
				<li><span class="field">throws:</span> IOException      if an input/output error occurs</li>
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result"><code>true</code></span>
		<span class="method-name">
			processRoles
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">&$request</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$response</span>, <span class="var-type"><a href="../../php-mvc/ActionConfig.html">ActionConfig</a></span>&nbsp;<span class="var-name">&$mapping</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">request</span>
				<span class="var-name">&$request</span><span class="var-description">: The servlet request we are processing</span>			</li>
					<li>
				<span class="var-type">response</span>
				<span class="var-name">&$response</span><span class="var-description">: The servlet response we are creating</span>			</li>
					<li>
				<span class="var-type">mapping</span>
				<span class="var-name">&$mapping</span><span class="var-description">: The mapping we are using</span>			</li>
				</ul>
		
			
	</div>
<a name="methodprocessValidate" id="processValidate"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">processValidate</span> (line <span class="line-number">545</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">&lt;p&gt;If this request was not cancelled, and the request's</p>
<p class="description"><p>ActionMapping} has not disabled validation, call the  <div class="src-code"><ol><li><div class="src-line"><span class="src-id">validate</span></div></li>
</ol></div> method of the specified <a href="../../php-mvc/action/ActionForm.html">ActionForm</a>, and  forward to the input path if there were any errors. Return  <div class="src-code"><ol><li><div class="src-line"><span class="src-id">true</span></div></li>
</ol></div> if we should continue processing, or  <div class="src-code"><ol><li><div class="src-line"><span class="src-id">false</span></div></li>
</ol></div> if we have already forwarded control back to the  input form.&lt;/p&gt;</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> to continue normal processing;          <div class="src-code"><ol><li><div class="src-line"><span class="src-id">false</span></div></li>
</ol></div> if a response has been created.</li>
				<li><span class="field">throws:</span> IOException      if an input/output error occurs</li>
				<li><span class="field">throws:</span> ServletException if a servlet exception occurs</li>
				<li><span class="field">throws:</span> InvalidCancelException if a cancellation is attempted          without the proper action configuration.</li>
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result"><code>true</code></span>
		<span class="method-name">
			processValidate
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">&$request</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$response</span>, <span class="var-type">form</span>&nbsp;<span class="var-name">&$form</span>, <span class="var-type"><a href="../../php-mvc/ActionConfig.html">ActionConfig</a></span>&nbsp;<span class="var-name">&$mapping</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">request</span>
				<span class="var-name">&$request</span><span class="var-description">: The servlet request we are processing</span>			</li>
					<li>
				<span class="var-type">response</span>
				<span class="var-name">&$response</span><span class="var-description">: The servlet response we are creating</span>			</li>
					<li>
				<span class="var-type">form</span>
				<span class="var-name">&$form</span><span class="var-description">: The ActionForm instance we are populating</span>			</li>
					<li>
				<span class="var-type">mapping</span>
				<span class="var-name">&$mapping</span><span class="var-description">: The ActionMapping we are using</span>			</li>
				</ul>
		
			
	</div>
						
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Fri, 08 Feb 2008 14:32:42 +0200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
	</p>
	</div></body>
</html>